Skip to main content
GET
/
v1
/
agents
List Agents (Minimal)
curl --request GET \
  --url https://api.xpander.ai/v1/agents \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "icon": "<string>",
      "status": "DRAFT",
      "organization_id": "<string>",
      "deployment_type": "serverless",
      "created_at": "2023-11-07T05:31:56Z",
      "instructions": {
        "role": [
          "<string>"
        ],
        "goal": [
          "<string>"
        ],
        "general": "<string>"
      },
      "model_provider": "openai",
      "llm_api_base": "<string>",
      "model_name": "<string>",
      "framework": "<string>",
      "using_nemo": true,
      "is_coordinate_mode": true
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123,
  "total_pages": 123
}
Retrieve a paginated list of AI agents with minimal information including ID, name, and deployment status. This endpoint provides a lightweight way to browse available agents without fetching full configuration details.

​
Query Parameters

​
page
integer
default:1
Page number (starting from 1)
​
per_page
integer
default:20
Items per page (maximum 50)

​
Response

Returns a paginated list of agents with detailed information:
​
items
array
Array of agent objects
​
total
integer
Total number of agents across all pages
​
page
integer
Current page number
​
per_page
integer
Number of items per page
​
total_pages
integer
Total number of pages available

​
Example Request

curl -X GET -H "x-api-key: YOUR_API_KEY" \
  "https://api.xpander.ai/v1/agents?page=1&per_page=2"

​
Example Response

{
  "items": [
    {
      "id": "0045cf07-8af6-4c69-8d13-0a13c631a5d0",
      "name": "DevOps AI Agent",
      "icon": "🚀",
      "status": "ACTIVE",
      "organization_id": "91fbe9bc-35b3-41e8-b59d-922fb5a0f031",
      "deployment_type": "container",
      "created_at": "2025-08-22T01:45:30.341088Z",
      "instructions": {
        "role": [
          "users can't access your files so upload the files and use markdwon when comment with public link. ",
          "Don't stop until complete all tools are valid.",
          "generate_diagram can fail , retry with different code "
        ],
        "goal": [],
        "general": "AI DevOps"
      },
      "model_provider": "openai",
      "llm_api_base": null,
      "model_name": "gpt-4.1",
      "framework": "agno",
      "using_nemo": false,
      "is_coordinate_mode": false
    },
    {
      "id": "11cf5b70-7743-4d5f-a739-3f94fef8ec0f",
      "name": "Test Agent - DELETE ME",
      "icon": "🚀",
      "status": "ACTIVE",
      "organization_id": "91fbe9bc-35b3-41e8-b59d-922fb5a0f031",
      "deployment_type": "serverless",
      "created_at": "2025-11-06T15:41:14.673977Z",
      "instructions": {
        "role": [],
        "goal": [],
        "general": ""
      },
      "model_provider": "openai",
      "llm_api_base": null,
      "model_name": "gpt-4.1",
      "framework": "agno",
      "using_nemo": false,
      "is_coordinate_mode": false
    }
  ],
  "total": 19,
  "page": 1,
  "per_page": 2,
  "total_pages": 10
}

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Query Parameters

​
page
integer
default:1

Page number (starting from 1)

Required range: x >= 1
​
per_page
integer
default:20

Items per page (max 50)

Required range: 1 <= x <= 50

Response

Successful Response

​
items
MinimalAIAgent · object[]
required
​
total
integer
required
​
page
integer
required
​
per_page
integer
required
​
total_pages
integer
required